/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package cn.zzdt4j.core.executor.plugin;

import cn.zzdt4j.core.executor.plugin.manager.ThreadPoolPluginManager;
import cn.zzdt4j.core.executor.plugin.manager.ThreadPoolPluginSupport;

/**
 * A superclass interface for a thread pool plug-in that can generally provide some operations that the original thread pool did not have。
 * <p>
 * These operations can be {@link ThreadPoolPluginSupport#register(ThreadPoolPlugin)} with a register
 *
 * @author by <a href="mailto:ligang941012@gmail.com">gang.Li</a>
 * @since 2023/10/24 1:19
 */
public interface ThreadPoolPlugin {

    /**
     * Get id.{@link Class#getSimpleName()} will be returned by default.
     *
     * @return id
     */
    default String getId() {
        return this.getClass().getSimpleName();
    }

    /**
     * Callback when plugin register into manager.
     *
     * @see ThreadPoolPluginSupport#register(ThreadPoolPlugin)
     */
    default void start() {
    }

    /**
     * Callback when plugin unregister from manager.
     *
     * @see ThreadPoolPluginManager#unregister
     */
    default void stop() {
    }

    /**
     * Get plugin runtime info.
     *
     * @return plugin runtime info
     */
    default PluginRuntime getPluginRuntime() {
        return new PluginRuntime(getId());
    }
}
